[Chore] Fix documentation badge link in README.md#56
Conversation
Summary of ChangesHello @haochengxia, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request addresses a minor but important chore by fixing a broken documentation badge link within the project's Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request fixes a broken link for the documentation badge in the README.md file. The fix correctly resolves the invalid markdown syntax. However, I've provided a suggestion to point the badge to the live documentation website instead of the GitHub Actions workflow. This would offer a more direct and user-friendly experience for those looking to read the documentation.
|
|
||
| [](https://github.com/cacheMon/libCacheSim-python/actions/workflows/build.yml) | ||
| []([docs.libcachesim.com/python](https://github.com/cacheMon/libCacheSim-python/actions/workflows/docs.yml)) | ||
| [](https://github.com/cacheMon/libCacheSim-python/actions/workflows/docs.yml) |
There was a problem hiding this comment.
Thanks for fixing the broken link! While linking to the GitHub Actions workflow is valid and consistent with the 'Build' badge, it's generally more user-friendly for a 'Documentation' badge to link directly to the live documentation website. This allows users to access the docs with a single click, as the build status is already conveyed by the badge itself. I'd suggest using the site_url from docs/mkdocs.yml for this link.
| [](https://github.com/cacheMon/libCacheSim-python/actions/workflows/docs.yml) | |
| [](https://cachemon.github.io/libCacheSim-python/) |
1 participant
No description provided.